MarkLogic 9 Product Documentation
GET /manage/v2/certificate-templates/{id|name}/propertiesSummary
This resource address returns the properties of the specified certificate
template.
| URL Parameters |
| format |
The format of the returned data. Can be either
json or xml (default). This value overrides the Accept header if
both are present. |
| Request Headers |
| Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
| Response Headers |
| Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
|
Response
Upon success, MarkLogic Server returns status code 200 (OK), and the response
body contains the requested data. A status code of 401 (Unauthorized) is returned if the user
does not have the necessary privileges. A status code of 404 (no such user) is returned if the
user does not exist.
Required Privileges
This operation requires the
security and
manage-admin roles.
Usage Notes
The structure of the output returned from
this REST API is as follows:
template-id
A certificate template id. The template-id element is not permitted
when using HTTP POST to create a new template. It is permitted
in HTTP PUT, as a convenience,
but must have the same value as returned by HTTP GET.
template-name
The name of the certificate request template.
template-description
A description of the certificate request template.
template-version
The certificate template's version.
key-type
The type of key to use (e.g. rsa).
key-options
The options for generating keys.
This is a complex structure with the following children:
key-length
The permitted key lengths.
pass-phrase
The pass phrase.
req
An X.509 certificate request
This is a complex structure with the following children:
version
The X509 version.
subject
The subject for a certificate or certificate request. You should
fill in as many of these fields as possible because individual
certificate authorities have specific requirements for which fields
must have values. If a required field is missing, a certificate
authority will typically reject your certificate request with a
cryptic error message that your request is bad.
This is a complex structure with the following children:
countryName
A two character country code (e.g. "US").
stateOrProvinceName
The state or province your server is in.
localityName
The city your server is in.
organizationName
The organization or company your server belongs to (e.g. MarkLogic).
organizationalUnitName
The organizational unit your server belongs to (e.g. Engineering).
emailAddress
The email address to contact regarding your server
(e.g. webmaster@yourcompany.com).
commonName
The common name of your server (e.g. www.yourcompany.com). This may be
left blank when creating a certificate template, since individual
servers will use their own host name.
v3ext
The X509v3 extensions.
Example
http://localhost:8002/manage/v2/certificate-templates/myTemplate/properties
==> Returns the properties of the certificate template, "myTemplate,"
from the Security database.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.